Interface IoEComponent

All Superinterfaces:
IPCObject, Port, Process
All Known Subinterfaces:
CustomIO
All Known Implementing Classes:
CustomIOImpl, IoEComponentImpl

public interface IoEComponent extends Port
Information provided by the PKI file:

    \class IoEComponent
    
    \brief IoEComponent holds and manipulates the IoEComponent on IoE devices.
    
Author:
Auto-generated
  • Method Details

    • getSlotName

      String getSlotName()
      Information provided by the PKI file:
      
          \brief Returns the name of the slot.
          
          \return string, the name of the slot.
          
              
      Returns:
      String Returns a String
    • getSlotNumber

      int getSlotNumber()
      Information provided by the PKI file:
      
          \brief Returns the number of the slot.
          
          \return int, the number of the slot.
          
              
      Returns:
      int Returns a int
    • getComponentType

      String getComponentType()
      Information provided by the PKI file:
      
          \brief Returns the type of the component.
          
          \return string, type of the component.
          
              
      Returns:
      String Returns a String
    • setIsOutputMode

      void setIsOutputMode(boolean isOutput)
      Information provided by the PKI file:
      
          \brief set the flag of slot is using output mode or not.
          
          \param isOutput, true if slot is using output mode, false otherwise.
          
              
      Parameters:
      isOutput - Takes in a parameter of isOutput
    • isOutputMode

      boolean isOutputMode()
      Information provided by the PKI file:
      
          \brief Returns true if the slot is using output mode, otherwise false.
          
          \return bool, true if the slot is using output mode, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isInputMode

      boolean isInputMode()
      Information provided by the PKI file:
      
          \brief Returns true if the slot is using input mode, otherwise false.
          
          \return bool, true if the slot is using input mode, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • digitalWrite

      void digitalWrite(int value)
      Information provided by the PKI file:
      
          \brief digital write a value to the slot.
          
          \param value, the value to write to the slot.
          
              
      Parameters:
      value - Takes in a parameter of value
    • digitalRead

      int digitalRead()
      Information provided by the PKI file:
      
          \brief Returns int digital read from the slot.
          
          \return bool, int digital read from the slot.
          
              
      Returns:
      int Returns a int
    • analogWrite

      void analogWrite(int value)
      Information provided by the PKI file:
      
          \brief analog write a value to the slot.
          
          \param value, the value to write to the slot.
          
              
      Parameters:
      value - Takes in a parameter of value
    • analogRead

      int analogRead()
      Information provided by the PKI file:
      
          \brief Returns int analog read from the slot.
          
          \return bool, int analog read from the slot.
          
              
      Returns:
      int Returns a int
    • customWrite

      void customWrite(String value)
      Information provided by the PKI file:
      
          \brief custom write a string to the slot.
          
          \param value, the string to write to the slot.
          
              
      Parameters:
      value - Takes in a parameter of value
    • customRead

      String customRead()
      Information provided by the PKI file:
      
          \brief Returns the string custom read from the slot.
          
          \return string, the string custom read from the slot.
          
              
      Returns:
      String Returns a String